Procurement APIs
Creates a new purchase order
| HTTP method | POST |
| URI | https://api.rambase.net/procurement/orders |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 201 |
| API resource identifier | 2998, version 9 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
SuppliersReference
Suppliers/sellers reference. Typically a person.
This field is optional.
>{String}</SuppliersReference>SuppliersReferenceNumber
Suppliers/sellers reference number. Typically to an external system.
This field is optional.
>{String}</SuppliersReferenceNumber>Type
Type of purchase order
Applicable domain values can be found here
This field is optional.
>{String}</Type>Currency
Three character code following the ISO 4217 standard
Applicable domain values can be found here
This field is optional.
>{String}</Currency>Note
Additional information regarding the object (free text). This note might be visible to customers/suppliers.
This field is optional.
>{String}</Note>Location
This field is optional.
>LocationId
Location identifier
Minimum value: 10000
This field is optional.
>{Integer}</LocationId>Assignee
The user who has been assigned to work with this object.
This field is optional.
>UserId
User identifier
Minimum value: 100
This field is optional.
>{Integer}</UserId>SupplierId
Required/mandatory field
RamBase supplier identifier
Minimum value: 100
>{Integer}</SupplierId>ShipFrom
This field is optional.
>AddressId
Address identifier
Minimum value: 1
This field is optional.
>{Integer}</AddressId>Shipment
This field is optional.
>DeliveryTerms
Default delivery terms for the supplier. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce).
Applicable domain values can be found here
This field is optional.
>{String}</DeliveryTerms>DeliveryTermPlace
A named place, which, together with the content of Delivery terms, determines where and when the costs, responsibility and risk for a shipment are transferred from the seller to the buye
This field is optional.
>{String}</DeliveryTermPlace>ShippingService
This field is optional.
>ShippingServiceId
Shipping service identifier
Minimum value: 100000
This field is optional.
>{Integer}</ShippingServiceId>Payment
This field is optional.
>PaymentTerms
Terms of payment. Defaut value is retrieved from the supplier.
Applicable domain values can be found here
This field is optional.
>{String}</PaymentTerms>SuppliersReference
Suppliers/sellers reference. Typically a person.
This field is optional.
": "{String}",SuppliersReferenceNumber
Suppliers/sellers reference number. Typically to an external system.
This field is optional.
": "{String}",Type
Type of purchase order
Applicable domain values can be found here
This field is optional.
": "{String}",Currency
Three character code following the ISO 4217 standard
Applicable domain values can be found here
This field is optional.
": "{String}",Note
Additional information regarding the object (free text). This note might be visible to customers/suppliers.
This field is optional.
": "{String}",Location
This field is optional.
": {LocationId
Location identifier
Minimum value: 10000
This field is optional.
": "{Integer}"Assignee
The user who has been assigned to work with this object.
This field is optional.
": {UserId
User identifier
Minimum value: 100
This field is optional.
": "{Integer}"SupplierId
Required/mandatory field
RamBase supplier identifier
Minimum value: 100
": "{Integer}"ShipFrom
This field is optional.
": {AddressId
Address identifier
Minimum value: 1
This field is optional.
": "{Integer}"Shipment
This field is optional.
": {DeliveryTerms
Default delivery terms for the supplier. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce).
Applicable domain values can be found here
This field is optional.
": "{String}",DeliveryTermPlace
A named place, which, together with the content of Delivery terms, determines where and when the costs, responsibility and risk for a shipment are transferred from the seller to the buye
This field is optional.
": "{String}",ShippingService
This field is optional.
": {ShippingServiceId
Shipping service identifier
Minimum value: 100000
This field is optional.
": "{Integer}"Payment
This field is optional.
": {PaymentTerms
Terms of payment. Defaut value is retrieved from the supplier.
Applicable domain values can be found here
This field is optional.
": "{String}"The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
| $showCustomFields Boolean, optional | Set to "true" to include custom fields. Default value is false. |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
PurchaseOrderId
Purchase order identifier
>{Integer}</PurchaseOrderId>Status
Status of the purchase order
Possible domain values can be found here
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>UpdatedAt
Date and time of update
>{Datetime}</UpdatedAt>SuppliersReference
Suppliers/sellers reference. Typically a person.
>{String}</SuppliersReference>SuppliersReferenceNumber
Suppliers/sellers reference number. Typically to an external system.
>{String}</SuppliersReferenceNumber>BuyersReferenceNumber
Buyers reference number
>{String}</BuyersReferenceNumber>RegistrationDate
Date of registration
>{Date}</RegistrationDate>Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
>{String}</Currency>Note
Additional information regarding the object (free text). This note might be visible to customers/suppliers.
>{String}</Note>ShipToAttention
Attention of the ship to address. When changing ship to address, the ShipToAttention will be overridden by the attention of the new ship to address.
>{String}</ShipToAttention>LocationId
Location identifier
>{Integer}</LocationId>Name
Name of location
>{String}</Name>ShortName
Unique abbreviation/short name of the location
>{String}</ShortName>LocationLink
Location reference
>{String}</LocationLink>Assignee
The user who has been assigned to work with this object.
>UserId
User identifier
>{Integer}</UserId>Name
Name of the user
>{String}</Name>FirstName
First name of the user
>{String}</FirstName>UserLink
User reference
>{String}</UserLink>SupplierId
RamBase supplier identifier
>{Integer}</SupplierId>Name
Name of supplier (name of company or surname/familyname/lastname of a person)
>ConfirmedDeliveryDateBuffer
If the confirmed delivery date is unreliable, you can specify a buffer in days to be added.
This buffer will be used when the requested delivery date for purchase orders is calculated.
This buffer will also be added to the confirmed delivery date when creating purchase order responses.
Attention
Attention note.
>{String}</Attention>AddressLine1
First address line
>{String}</AddressLine1>AddressLine2
Second address line
>{String}</AddressLine2>PostalCode
Postalcode/Postcode/ZIP
>{String}</PostalCode>City
City/town/village
>{String}</City>Region
Region/province/state
>{String}</Region>CountryCode
Two-character code (ISO 3166) identifying the country.
>{String}</CountryCode>Country
English name of country.
>{String}</Country>SupplierLink
Supplier reference
>{String}</SupplierLink>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>TotalAmount
The total amount in object currency, including VAT
>{Decimal}</TotalAmount>Currency
Currency used in conversion. Default is company accounting currency. Three character code following the ISO 4217 standard.
>{String}</Currency>ExchangeRate
The exchange rate used in convertion
>{Decimal}</ExchangeRate>TotalAmount
The total amount in company currency, including VAT.
>{Decimal}</TotalAmount>Name
Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.
>{String}</Name>Firstname
Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.
>{String}</Firstname>AddressLine1
First address line
>{String}</AddressLine1>AddressLine2
Second address line
>{String}</AddressLine2>PostalCode
Postalcode/Postcode/ZIP
>{String}</PostalCode>City
City/town/village
>{String}</City>Region
Region/province/state
>{String}</Region>CountryCode
Two-character code (ISO 3166) identifying the country.
>{String}</CountryCode>Country
English name of country.
>{String}</Country>Database
Database of the object
>{String}</Database>ItemId
Item-number of the object
>{Integer}</ItemId>ItemType
Type of item
>{String}</ItemType>ItemLink
API reference to the item
>{String}</ItemLink>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>ObjectLink
API reference to the object
>{String}</ObjectLink>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>AddressId
Address identifier
>{Integer}</AddressId>Name
Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.
>{String}</Name>AddressLine1
First address line
>{String}</AddressLine1>AddressLine2
Second address line
>{String}</AddressLine2>PostalCode
Postalcode/Postcode/ZIP
>{String}</PostalCode>City
City/town/village
>{String}</City>Region
Region/province/state
>{String}</Region>CountryCode
Two-character code (ISO 3166) identifying the country.
>{String}</CountryCode>Country
English name of country.
>{String}</Country>AddressLink
Supplier address reference
>{String}</AddressLink>DeliveryTerms
Default delivery terms for the supplier. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce).
Possible domain values can be found here
>{String}</DeliveryTerms>DeliveryTermPlace
A named place, which, together with the content of Delivery terms, determines where and when the costs, responsibility and risk for a shipment are transferred from the seller to the buye
>{String}</DeliveryTermPlace>ShippingServiceId
Shipping service identifier
>{Integer}</ShippingServiceId>Name
Name of shipping service
>{String}</Name>CarrierId
Carrier identifier
>{Integer}</CarrierId>CarrierLink
Carrier reference
>{String}</CarrierLink>ShippingServiceLink
Shipping service reference
>{String}</ShippingServiceLink>PaymentTerms
Terms of payment. Defaut value is retrieved from the supplier.
Possible domain values can be found here
>{String}</PaymentTerms>NotificationId
Notification identifier
>{Integer}</NotificationId>Status
Status of the notification
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Message
The message from the notification definition, expanded with parameters.
>{String}</Message>TranslatedMessage
The translated message from the notification definition, expanded with parameters.
>{String}</TranslatedMessage>NotificationTypeId
Notification type identifier
>{String}</NotificationTypeId>Category
Category of notification type (warning, information etc)
Possible domain values can be found here
>{String}</Category>NotificationTypeLink
Notification type reference
>{String}</NotificationTypeLink>NotificationLink
Notification reference
>{String}</NotificationLink>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>Name
Name of the customer/supplier, or last name if it is a person.
>{String}</Name>FirstName
First name of the customer/supplier
>{String}</FirstName>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>ObjectLink
API reference to the object
>{String}</ObjectLink>PurchaseOrderId
Purchase order identifier
": "{Integer}",Status
Status of the purchase order
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",UpdatedAt
Date and time of update
": "{Datetime}",SuppliersReference
Suppliers/sellers reference. Typically a person.
": "{String}",SuppliersReferenceNumber
Suppliers/sellers reference number. Typically to an external system.
": "{String}",BuyersReferenceNumber
Buyers reference number
": "{String}",RegistrationDate
Date of registration
": "{Date}",Type
Type of purchase order
Possible domain values can be found here
": "{String}",SubType
Subtype of purchase order
Possible domain values can be found here
": "{String}",Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
": "{String}",Note
Additional information regarding the object (free text). This note might be visible to customers/suppliers.
": "{String}",ShipToAttention
Attention of the ship to address. When changing ship to address, the ShipToAttention will be overridden by the attention of the new ship to address.
": "{String}",LocationId
Location identifier
": "{Integer}",Name
Name of location
": "{String}",ShortName
Unique abbreviation/short name of the location
": "{String}",LocationLink
Location reference
": "{String}"Assignee
The user who has been assigned to work with this object.
": {UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"SupplierId
RamBase supplier identifier
": "{Integer}",Name
Name of supplier (name of company or surname/familyname/lastname of a person)
": {ConfirmedDeliveryDateBuffer
If the confirmed delivery date is unreliable, you can specify a buffer in days to be added.
This buffer will be used when the requested delivery date for purchase orders is calculated.
This buffer will also be added to the confirmed delivery date when creating purchase order responses.
Attention
Attention note.
": "{String}",AddressLine1
First address line
": "{String}",AddressLine2
Second address line
": "{String}",PostalCode
Postalcode/Postcode/ZIP
": "{String}",City
City/town/village
": "{String}",Region
Region/province/state
": "{String}",CountryCode
Two-character code (ISO 3166) identifying the country.
": "{String}",Country
English name of country.
": "{String}"SupplierLink
Supplier reference
": "{String}"Currency
Three character code following the ISO 4217 standard
": "{String}",TotalAmount
The total amount in object currency, including VAT
": "{Decimal}",Currency
Currency used in conversion. Default is company accounting currency. Three character code following the ISO 4217 standard.
": "{String}",ExchangeRate
The exchange rate used in convertion
": "{Decimal}",TotalAmount
The total amount in company currency, including VAT.
": "{Decimal}"Name
Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.
": "{String}",Firstname
Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.
": "{String}",AddressLine1
First address line
": "{String}",AddressLine2
Second address line
": "{String}",PostalCode
Postalcode/Postcode/ZIP
": "{String}",City
City/town/village
": "{String}",Region
Region/province/state
": "{String}",CountryCode
Two-character code (ISO 3166) identifying the country.
": "{String}",Country
English name of country.
": "{String}",Database
Database of the object
": "{String}",ItemId
Item-number of the object
": "{Integer}",ItemType
Type of item
": "{String}",ItemLink
API reference to the item
": "{String}",ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",ObjectLink
API reference to the object
": "{String}",RamBaseKey
Internal RamBase identifier of the object/item
": "{String}"AddressId
Address identifier
": "{Integer}",Name
Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.
": "{String}",AddressLine1
First address line
": "{String}",AddressLine2
Second address line
": "{String}",PostalCode
Postalcode/Postcode/ZIP
": "{String}",City
City/town/village
": "{String}",Region
Region/province/state
": "{String}",CountryCode
Two-character code (ISO 3166) identifying the country.
": "{String}",Country
English name of country.
": "{String}",AddressLink
Supplier address reference
": "{String}"DeliveryTerms
Default delivery terms for the supplier. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce).
Possible domain values can be found here
": "{String}",DeliveryTermPlace
A named place, which, together with the content of Delivery terms, determines where and when the costs, responsibility and risk for a shipment are transferred from the seller to the buye
": "{String}",ShippingServiceId
Shipping service identifier
": "{Integer}",Name
Name of shipping service
": "{String}",CarrierId
Carrier identifier
": "{Integer}",CarrierLink
Carrier reference
": "{String}"ShippingServiceLink
Shipping service reference
": "{String}"PaymentTerms
Terms of payment. Defaut value is retrieved from the supplier.
Possible domain values can be found here
": "{String}",NotificationId
Notification identifier
": "{Integer}",Status
Status of the notification
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Message
The message from the notification definition, expanded with parameters.
": "{String}",TranslatedMessage
The translated message from the notification definition, expanded with parameters.
": "{String}",NotificationTypeId
Notification type identifier
": "{String}",Category
Category of notification type (warning, information etc)
Possible domain values can be found here
": "{String}",NotificationTypeLink
Notification type reference
": "{String}"NotificationLink
Notification reference
": "{String}",ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",Name
Name of the customer/supplier, or last name if it is a person.
": "{String}",FirstName
First name of the customer/supplier
": "{String}",RamBaseKey
Internal RamBase identifier of the object/item
": "{String}",ObjectLink
API reference to the object
": "{String}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 101420 HTTP 404 | Setting definition not found |
| Error 100199 HTTP 404 | Location not found |
| Error 102229 HTTP 400 | Location {0} is already defined on the product |
| Error 101493 HTTP 400 | Illegal update: New VAT code has VAT percentage different from old VAT code. |
| Error 101494 HTTP 400 | Illegal VAT code: Vat code and document has different VAT number |
| Error 101496 HTTP 400 | Illegal VAT code {0}: Check VAT FromPeriod and ToPeriod |
| Error 101495 HTTP 400 | Illegal VAT code: {0} |
| Error 107641 HTTP 400 | VAT code {0} has not an active VAT code setup |
| Error 100984 HTTP 400 | Illegal update. The General ledger posting has ST>4 |
| Error 100985 HTTP 400 | Illegal update. The General ledger posting has AGIO-calculation |
| Error 108105 HTTP 400 | Linking is not allowed for project order items for which have manually accrued handling |
| Error 108106 HTTP 400 | Linking is not allowed for project order item which is based on expense log |
| Error 101469 HTTP 400 | The object is not open for edit. To change currency, the object must be in status 1. |
| Error 101562 HTTP 400 | This currency is not supported by the supplier |
| Error 101689 HTTP 400 | You cannot change this purchase order to type 'REQUISITION' as it contains standard products (type not equal to X or V). |
| Error 101690 HTTP 400 | You cannot change this purchase order to type 'REQUISITION' as it has assignments. |